Blog

Eric Peterson

December 13, 2017

Spread the word


Share your thoughts

We enjoyed bringing you tips for [CommandBox](https://www.ortussolutions.com/blog/category/12-tips-of-commandbox-christmas) and [ContentBox](https://www.ortussolutions.com/blog/category/12-tips-of-contentbox-christmas) last year for the 12 days of Christmas so much that we decided to do it again! This year, I'm happy to show you 12 different modules currently hosted on ForgeBox just waiting to make your life easier. So grab a hot drink and cozy up for the **12 Tips of (ForgeBox) Christmas**.

Hyper

Hyper exists to make your life making network requests easier.

Here's the simplest Hyper example:

var res = hyper.get( "https://swapi.co/api/films/7" );

The HyperResponse object returned has a few helpers to make it easy to work with requests, including retrieving the status code, inspecting headers, and deserializing json bodies.

The more complex you get with your HTTP requests, the more Hyper shines. A POST request looks like so:

var res = hyper.post( "https://swapi.co/api/films", {
    "title" = "The Last Jedi",
    "episode_id" = 8,
    "release_date" = "2018-12-15"
} );

This sends a json body, by default. Need form fields and a custom header?

var res = hyper
    .asFormFields()
    .withHeaders( { "X-Prerelease-Token" = token } )
    .post( "https://swapi.co/api/films", {
        "title" = "The Last Jedi",
        "episode_id" = 8,
        "release_date" = "2018-12-15"
    } );

While this is a nice syntax improvement over cfhttp, Hyper was built to solve the pain points around writing SDK's like GitHub, Stripe, and Twilio. When working with services like these, there is a handful of boilerplate headers, parameters, or other values you need to set.

Hyper lets you create clients — partially configured instances that pass on their defaults to every request made from them. You create a new client with WireBox (most likely in your config/WireBox.cfc):

map( "GitHubClient" )
    .to( "hyper.models.HyperBuilder" )
    .asSingleton()
    .initWith(
        baseUrl = "https://api.github.com",
        headers = {
            "Authorization" = getSetting( "GITHUB_TOKEN" )
        }
    );

This client can then be injected and used elsewhere in your application:

component {

    property name="githubClient" inject="GithubClient";

    function getRepos() {
        return githubClient.get( "/user/repos" );
    }

}

No more repeating yourself all over the place with the same defaults! And if you need to override a default, just set it as normal. Hyper has a full fluent API to set all the parameters you would need.

So check out the documentation over on ForgeBox and stop rewriting the same cfhttp code over and over again.

Merry Christmas!

Add Your Comment

(1)

Dec 14, 2017 06:56:06 UTC

by Chris Geirman

Impressive! I recall there being many nitnoid issues with json deserialization in CF. I don't recall specific pain points however. Assuming you know what I mean, have you solved for them?

Recent Entries

Partner with BoxLang and Ortus at Into the Box 2025: Empowering the Future of Modern Software Development!

Partner with BoxLang and Ortus at Into the Box 2025: Empowering the Future of Modern Software Development!

At Ortus Solutions, we’ve always been at the forefront of innovation in the ColdFusion ecosystem. From pioneering modern ColdFusion practices to developing cutting-edge tools and frameworks, we’ve been passionate to help and sup[port the community into shaping the future of web development.That’s why we decided to build BoxLang, our new JVM programming language that not only builds on the strengths of ColdFusion but takes modern software development to the next level.

Maria Jose Herrera
Maria Jose Herrera
December 23, 2024
Why BoxLang When You Have Kotlin, Groovy, Scala, and more…

Why BoxLang When You Have Kotlin, Groovy, Scala, and more…

As we approach a stable release of BoxLang and our continued marketing reaches more folks, many have asked about its purpose. Why create a new language when the JVM ecosystem already includes established languages like Kotlin, Groovy, and Scala, to name a few.

Luis Majano
Luis Majano
December 18, 2024